Capsule API Example
Loading...
Searching...
No Matches
CNFBCalibrator.h
Go to the documentation of this file.
1// Copyright. 2019 - 2024 PSBD. All rights reserved.
2
3#pragma once
4
5#include "CDefinesPrivate.h"
6#include "CDevice.h"
7#include "CError.h"
8
9#ifdef __cplusplus
10extern "C" {
11#endif
12
16CLC_CLASS_WN(NFBCalibratorPrivate, clCNFBCalibrator);
17
24
30
67
76CL_DLL clCNFBCalibrator clCNFBCalibrator_CreateOrGet(clCDevice device) NOEXCEPT;
77
87
94CL_DLL void clCNFBCalibrator_CalibrateIndividualNFBQuick(clCNFBCalibrator calibrator, clCError* error) NOEXCEPT;
95
102CL_DLL void clCNFBCalibrator_ImportIndividualNFBData(clCNFBCalibrator calibrator, const clCIndividualNFBData* individualNfbData, clCError* error) NOEXCEPT;
103
111CL_DLL void clCNFBCalibrator_GetIndividualNFB(clCNFBCalibrator calibrator, clCIndividualNFBData* nfbData, clCError* error) NOEXCEPT;
112
119CL_DLL bool clCNFBCalibrator_IsCalibrated(clCNFBCalibrator calibrator) NOEXCEPT;
126CL_DLL bool clCNFBCalibrator_HasCalibrationFailed(clCNFBCalibrator calibrator) NOEXCEPT;
127
128typedef void (*clCNFBCalibrator_CalibrationStageFinishedHandler)(clCNFBCalibrator calibrator) NOEXCEPT;
130
131typedef void (*clCNFBCalibrator_CalibratedHandler)(clCNFBCalibrator calibrator, const clCIndividualNFBData*) NOEXCEPT;
133
134#ifdef __cplusplus
135}
136#endif
#define NOEXCEPT
Definition CDefinesPrivate.h:82
#define CL_DLL
Definition CDefinesPrivate.h:51
#define CLC_CLASS_WN(Wrapped, Name)
Definition CDefinesPrivate.h:84
clCIndividualNFBCalibrationStage
Definition CNFBCalibrator.h:18
@ clCIndividualNFBCalibrationStage_4
Definition CNFBCalibrator.h:22
@ clCIndividualNFBCalibrationStage_1
Definition CNFBCalibrator.h:19
@ clCIndividualNFBCalibrationStage_3
Definition CNFBCalibrator.h:21
@ clCIndividualNFBCalibrationStage_2
Definition CNFBCalibrator.h:20
CL_DLL void clCNFBCalibrator_CalibrateIndividualNFB(clCNFBCalibrator calibrator, clCIndividualNFBCalibrationStage stage, clCError *error) NOEXCEPT
Start stage of individual NFB calibration.
CL_DLL void clCNFBCalibrator_GetIndividualNFB(clCNFBCalibrator calibrator, clCIndividualNFBData *nfbData, clCError *error) NOEXCEPT
Get individual NFB metrics.
CL_DLL clCNFBCalibrator clCNFBCalibrator_CreateOrGet(clCDevice device) NOEXCEPT
Obtain an individual NFB calibrator for the session. If not present, it'll be created.
CL_DLL bool clCNFBCalibrator_HasCalibrationFailed(clCNFBCalibrator calibrator) NOEXCEPT
Has calibration failed.
CL_DLL void clCNFBCalibrator_SetOnCalibratedEvent(clCNFBCalibrator calibrator, clCNFBCalibrator_CalibratedHandler handler) NOEXCEPT
void(* clCNFBCalibrator_CalibratedHandler)(clCNFBCalibrator calibrator, const clCIndividualNFBData *) NOEXCEPT
Definition CNFBCalibrator.h:131
CL_DLL void clCNFBCalibrator_SetOnCalibrationStageFinishedEvent(clCNFBCalibrator calibrator, clCNFBCalibrator_CalibrationStageFinishedHandler handler) NOEXCEPT
clCIndividualNFBCalibrationFailReason
Definition CNFBCalibrator.h:25
@ clC_IndividualNFBCalibrationFailReason_None
Definition CNFBCalibrator.h:26
@ clC_IndividualNFBCalibrationFailReason_PeakIsABorder
Definition CNFBCalibrator.h:28
@ clC_IndividualNFBCalibrationFailReason_TooManyArtifacts
Definition CNFBCalibrator.h:27
void(* clCNFBCalibrator_CalibrationStageFinishedHandler)(clCNFBCalibrator calibrator) NOEXCEPT
Definition CNFBCalibrator.h:128
struct clCIndividualNFBData clCIndividualNFBData
CL_DLL bool clCNFBCalibrator_IsCalibrated(clCNFBCalibrator calibrator) NOEXCEPT
Is calibration finished.
CL_DLL void clCNFBCalibrator_CalibrateIndividualNFBQuick(clCNFBCalibrator calibrator, clCError *error) NOEXCEPT
Start stage of quick individual NFB calibration.
CL_DLL void clCNFBCalibrator_ImportIndividualNFBData(clCNFBCalibrator calibrator, const clCIndividualNFBData *individualNfbData, clCError *error) NOEXCEPT
Import individual nfb data from external source.
Definition CError.h:28
Definition CNFBCalibrator.h:31
float individualPeakFrequency
Individual NFB peak frequency.
Definition CNFBCalibrator.h:41
float individualBandwidth
Individual NFB bandwidth.
Definition CNFBCalibrator.h:53
float individualNormalizedPower
NFB power.
Definition CNFBCalibrator.h:57
float individualPeakFrequencySuppression
Individual NFB peak frequency suppression.
Definition CNFBCalibrator.h:49
float upperFrequency
Right frequency bound.
Definition CNFBCalibrator.h:65
int64_t timestampMilli
Definition CNFBCalibrator.h:32
clCIndividualNFBCalibrationFailReason failReason
Definition CNFBCalibrator.h:33
float individualFrequency
Individual NFB frequency.
Definition CNFBCalibrator.h:37
float individualPeakFrequencyPower
Individual NFB peak frequency power.
Definition CNFBCalibrator.h:45
float lowerFrequency
Left frequency bound.
Definition CNFBCalibrator.h:61